<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaVirtualConnection: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="virtual_connection.html" title="Virtual connections">
<link rel="prev" href="GdaVproviderHub.html" title="GdaVproviderHub">
<link rel="next" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GdaVirtualConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="virtual_connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaVproviderHub.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaVconnectionDataModel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaVirtualConnection"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaVirtualConnection.top_of_page"></a>GdaVirtualConnection</span></h2>
<p>GdaVirtualConnection — Base class for all virtual connection objects</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaVirtualConnection.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open" title="gda_virtual_connection_open ()">gda_virtual_connection_open</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-open-extended" title="gda_virtual_connection_open_extended ()">gda_virtual_connection_open_extended</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()">gda_virtual_connection_internal_set_provider_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-get-provider-data" title="gda_virtual_connection_internal_get_provider_data ()">gda_virtual_connection_internal_get_provider_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaVirtualConnection.html#GdaVirtualConnection-struct" title="struct GdaVirtualConnection">GdaVirtualConnection</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>
        <span class="lineart">╰──</span> GdaVirtualConnection
            <span class="lineart">╰──</span> <a class="link" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">GdaVconnectionDataModel</a>
</pre>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaVirtualConnection implements
 <a class="link" href="GdaLockable.html" title="GdaLockable">GdaLockable</a>.</p>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;virtual/gda-ldap-connection.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.description"></a><h2>Description</h2>
<p>This is a base virtual class for all virtual connection implementations.</p>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-virtual-connection-open"></a><h3>gda_virtual_connection_open ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
gda_virtual_connection_open (<em class="parameter"><code><a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> *virtual_provider</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates and opens a new virtual connection using the <em class="parameter"><code>virtual_provider</code></em>
 provider. The returned value
is a new <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> which needs to be used to actually add some contents to the virtual connection.</p>
<div class="refsect3">
<a name="gda-virtual-connection-open.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>virtual_provider</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-virtual-connection-open.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-open-extended"></a><h3>gda_virtual_connection_open_extended ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
gda_virtual_connection_open_extended (<em class="parameter"><code><a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> *virtual_provider</code></em>,
                                      <em class="parameter"><code><a class="link" href="GdaConnection.html#GdaConnectionOptions" title="enum GdaConnectionOptions"><span class="type">GdaConnectionOptions</span></a> options</code></em>,
                                      <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates and opens a new virtual connection using the <em class="parameter"><code>virtual_provider</code></em>
 provider. If <em class="parameter"><code>options</code></em>

contains the <a class="link" href="GdaConnection.html#GDA-CONNECTION-OPTIONS-THREAD-ISOLATED:CAPS"><code class="literal">GDA_CONNECTION_OPTIONS_THREAD_ISOLATED</code></a> flag, then the returned connection will be
a thread wrapped connection, and the actual (wrapped) virtual connection can be obtained through
the "gda-virtual-connection" user property (use <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-get-data"><code class="function">g_object_get_data()</code></a> to get it).</p>
<p>The returned value is a new <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> which needs to be used to actually add some
contents to the virtual connection.</p>
<div class="refsect3">
<a name="gda-virtual-connection-open-extended.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>virtual_provider</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVirtualProvider.html" title="GdaVirtualProvider"><span class="type">GdaVirtualProvider</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>options</p></td>
<td class="parameter_description"><p>a set of options to specify the new connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-virtual-connection-open-extended.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if an error occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-internal-set-provider-data"></a><h3>gda_virtual_connection_internal_set_provider_data ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_virtual_connection_internal_set_provider_data
                               (<em class="parameter"><code><a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> *vcnc</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_func</code></em>);</pre>
<p>Note: calling this function more than once will not make it call <em class="parameter"><code>destroy_func</code></em>
 on any previously
set opaque <em class="parameter"><code>data</code></em>
, you'll have to do it yourself.</p>
<div class="refsect3">
<a name="gda-virtual-connection-internal-set-provider-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>vcnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>an opaque structure, known only to the provider for which <em class="parameter"><code>vcnc</code></em>
is opened</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>destroy_func</p></td>
<td class="parameter_description"><p>function to call when the connection closes and <em class="parameter"><code>data</code></em>
needs to be destroyed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-virtual-connection-internal-get-provider-data"></a><h3>gda_virtual_connection_internal_get_provider_data ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
gda_virtual_connection_internal_get_provider_data
                               (<em class="parameter"><code><a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection"><span class="type">GdaVirtualConnection</span></a> *vcnc</code></em>);</pre>
<p>Get the opaque pointer previously set using <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()"><code class="function">gda_virtual_connection_internal_set_provider_data()</code></a>.
If it's not set, then add a connection event and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<div class="refsect3">
<a name="gda-virtual-connection-internal-get-provider-data.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>vcnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-virtual-connection-internal-get-provider-data.returns"></a><h4>Returns</h4>
<p> the pointer to the opaque structure set using <a class="link" href="GdaVirtualConnection.html#gda-virtual-connection-internal-set-provider-data" title="gda_virtual_connection_internal_set_provider_data ()"><code class="function">gda_virtual_connection_internal_set_provider_data()</code></a></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaVirtualConnection.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaVirtualConnection-struct"></a><h3>struct GdaVirtualConnection</h3>
<pre class="programlisting">struct GdaVirtualConnection;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>